/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.indicator;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.hisp.dhis.common.BaseIdentifiableObject;
import org.hisp.dhis.common.DxfNamespaces;
import org.hisp.dhis.common.MetadataObject;
import org.hisp.dhis.schema.annotation.PropertyRange;

/**
 * An IndicatorGroupSet is a set of IndicatorGroups. It is by default exclusive, in the sense that
 * an Indicator can only be a member of one or zero of the IndicatorGroups in a IndicatorGroupSet.
 *
 * @author Lars Helge Overland
 */
@JacksonXmlRootElement(localName = "indicatorGroupSet", namespace = DxfNamespaces.DXF_2_0)
public class IndicatorGroupSet extends BaseIdentifiableObject implements MetadataObject {
  private String shortName;

  private String description;

  private Boolean compulsory = false;

  private List<IndicatorGroup> members = new ArrayList<>();

  // -------------------------------------------------------------------------
  // Constructors
  // -------------------------------------------------------------------------

  public IndicatorGroupSet() {}

  public IndicatorGroupSet(String name) {
    this(name, false);
  }

  public IndicatorGroupSet(String name, Boolean compulsory) {
    this(name, null, compulsory);
  }

  public IndicatorGroupSet(String name, String description, Boolean compulsory) {
    this.name = name;
    this.shortName = name;
    this.compulsory = compulsory;
    this.description = description;
  }

  // -------------------------------------------------------------------------
  // Logic
  // -------------------------------------------------------------------------

  public Collection<Indicator> getIndicators() {
    List<Indicator> indicators = new ArrayList<>();

    for (IndicatorGroup group : members) {
      indicators.addAll(group.getMembers());
    }

    return indicators;
  }

  public IndicatorGroup getGroup(Indicator indicator) {
    for (IndicatorGroup group : members) {
      if (group.getMembers().contains(indicator)) {
        return group;
      }
    }

    return null;
  }

  public Boolean isMemberOfIndicatorGroups(Indicator indicator) {
    for (IndicatorGroup group : members) {
      if (group.getMembers().contains(indicator)) {
        return true;
      }
    }

    return false;
  }

  public Boolean hasIndicatorGroups() {
    return members != null && members.size() > 0;
  }

  public List<IndicatorGroup> getSortedGroups() {
    List<IndicatorGroup> sortedGroups = new ArrayList<>(members);

    Collections.sort(sortedGroups);

    return sortedGroups;
  }

  // -------------------------------------------------------------------------
  // Logic
  // -------------------------------------------------------------------------

  public void removeAllIndicatorGroups() {
    members.clear();
  }

  public void addIndicatorGroup(IndicatorGroup indicatorGroup) {
    members.add(indicatorGroup);
    indicatorGroup.getGroupSets().add(this);
  }

  public void removeIndicatorGroup(IndicatorGroup indicatorGroup) {
    members.remove(indicatorGroup);
    indicatorGroup.getGroupSets().remove(this);
  }

  // -------------------------------------------------------------------------
  // Getters and setters
  // -------------------------------------------------------------------------

  @JsonProperty
  @JacksonXmlProperty(isAttribute = true)
  @PropertyRange(min = 1, max = 50)
  public String getShortName() {
    return shortName;
  }

  public void setShortName(String shortName) {
    this.shortName = shortName;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  @PropertyRange(min = 2)
  public String getDescription() {
    return description;
  }

  public void setDescription(String description) {
    this.description = description;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public Boolean isCompulsory() {
    if (compulsory == null) {
      return false;
    }

    return compulsory;
  }

  public void setCompulsory(Boolean compulsory) {
    this.compulsory = compulsory;
  }

  @JsonProperty("indicatorGroups")
  @JsonSerialize(contentAs = BaseIdentifiableObject.class)
  @JacksonXmlElementWrapper(localName = "indicatorGroups", namespace = DxfNamespaces.DXF_2_0)
  @JacksonXmlProperty(localName = "indicatorGroup", namespace = DxfNamespaces.DXF_2_0)
  public List<IndicatorGroup> getMembers() {
    return members;
  }

  public void setMembers(List<IndicatorGroup> members) {
    this.members = members;
  }
}
